GOODWE API

Author: Carol

2024-08-20 14:21

API, short for Application Programming Interface, is a set of rules and protocols that allows different software applications to communicate with each other.

It enables developers to define the structure of their APIs in a standardized format using JSON or YAML. Key components of an API document include endpoints, operations (HTTPS methods like GET, POST), request and response schemas, parameters, headers, authentication methods, and more. It helps developers and teams collaborate efficiently by providing a clear, machine-readable interface description that can be used to generate API clients, server stubs, and interactive API documentation.

GoodWe provides API services for data forwarding and batch remote control to our customers and third-parties. GOODWE offers API services through HTTPS protocols and KAFKA subscription method. There are three different types of APIs available for customers according to different application scenarios or requirements——OpenAPI, Real-time Data Monitoring API and Batch Remote Control Interface.

Functionally, the OpenAPI primarily focuses on business data processed by SEMS for customer calls, the Real-time Data Monitoring API focuses on forwarding raw device data directly to customers, and the Batch Remote Control Interface focuses on remote control functions.

OpenAPI

The OpenAPI is exclusively accessible to SEMS organization account users. This service provides users with comprehensive access to all devices within their local organization, facilitating both data retrieval and remote control capabilities. Additionally, the OpenAPI supports the retrieval of data from Datalogger, including weather station data, Datalogger data, and HomeKit data.

Using the HTTPS protocol, the OpenAPI enables customers to request data and control commands functions. The HTTPS protocol in APIs operates by enabling clients to send requests to servers using various methods (like GET, POST, PUT, DELETE), with the server responding with status codes and data based on the request's content and intent. The interfaces for accessing various data types are categorized into four main types: plant interface, device interface, remote control interface, and Datalogger interface. These interfaces are subject to specific calling frequency limits. The default frequency limit is 3600 calls per hour, If the access frequency exceeds the limit, an error warning will be returned.

Real-time Data Monitoring API

The Real-time Data Monitoring API, which uses the HTTPS protocol, is accessible to third-party suppliers. These suppliers are not required to establish plants on the SEMS platform, but they need to apply for API access credentials and establish a licensing agreement. Subsequently, they must add devices to the whitelist and obtain authorization from end users. Once these steps are completed, third-party suppliers can access the authorized devices listed in the whitelist.

Through the Real-time Data Monitoring API, third-party suppliers can retrieve real-time data from inverters. It supports simultaneous data retrieval from multiple inverters but does not facilitate remote control.